Activate or schedule activation of a User

Activates a User immediately or for a specified date range.

PUT{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/users/activate

Headers

HeaderValue
user_idLogin username (email)
api_keyAPI key of the user for authentication
Content-Typeapplication/json
Acceptapplication/json

Parameters

ParameterTypeRequiredDescription
accelqLoginUrlstringYesThe AccelQ login URL for API access.
tenantCodestringYesTenant code for identifying the organization.
user_idstringYesLogin username (email)
api_keystringYesAPI key of the user for authentication

Request Body

json
{
  "userPid": "25",
  "activeFrom": "2024-01-01",
  "activeTo": "2025-10-10"
}

Responses

200 - User activation successfully updated

json
{
  "userPid": "25",
  "firstName": "Test",
  "lastName": "User",
  "email": "Testuser@accelq.com",
  "active": true,
  "tenantAdmin": false,
  "assignedLicenses": [
    {
      "subscriptionId": "1724156779826",
      "subscriptionName": "1724156779826",
      "licenseBundleId": 3,
      "products": [
        "WEB",
        "MOBILE"
      ],
      "subscriptionType": "Non-commercial use"
    }
  ],
  "assignedProjects": [
    {
      "projectName": "accelq Project",
      "roleName": "SME",
      "isAdmin": false
    }
  ]
}

400 - Bad Request Error

json
{
  "error": "Active To date must be after Active From date"
}

403 - Forbidden - User does not have permission to activate users

json
{
  "error": "User does not have authorization to access this feature"
}

404 - User not found

json
{
  "error": "User with pid : '26' doesnot exist."
}

cURL Command Builder

URL Parameters

Headers

Request Sample (cURL)

curl -X PUT "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/users/activate" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "userPid": "25",
  "activeFrom": "2024-01-01",
  "activeTo": "2025-10-10"
}'